home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / lists / mint / l_1199 / 1758 < prev    next >
Encoding:
Internet Message Format  |  1994-08-27  |  2.4 KB
  1. Date: Sat, 23 Jul 1994 21:19:17 -0400
  2. From: "Nicholas S Castellano" <entropy@terminator.rs.itd.umich.edu>
  3. To: reschke@GOEDEL.UNI-MUENSTER.DE
  4. In-Reply-To: Julian Reschke's message of Sat, 23 Jul 94 11:06:51 MET DST <9407230906.AA14752@math.uni-muenster.de>
  5. Subject: New calls, manuals
  6.  
  7.  
  8. Here's a man page...the version string should be changed if this makes
  9. it into MiNT 1.11...I've assumed here that it will be in the h8 patch.
  10.  
  11. .TH Tsetitimer 2 "MiNT Programmer's Manual" "Version 1.10h8" "July 23, 1994"
  12. .SH NAME
  13. Tsetitimer \- schedule an interval timer
  14. .SH SYNOPSIS
  15. .nf
  16. LONG Tsetitimer( LONG which, LONG interval, LONG value, LONG ointerval, LONG ovalue );
  17. .fi
  18. .SH DESCRIPTION
  19. .I Tsetitimer
  20. is used to schedule a periodic timer.  One of three timers, specified by
  21. .I which ,
  22. may be selected.  Timer 0 runs in real time, and sends a SIGALRM upon
  23. expiration.  Timer 1 runs in process virtual time (that is, only when the
  24. process that scheduled the timer is running) and sends a SIGVTALRM upon
  25. expiration.  Timer 2 runs both in process virtual time and when the
  26. operating system is running on behalf of the process that scheduled it, and
  27. sends a SIGPROF upon expiration.
  28. .PP
  29. .I value
  30. is the address of a longword specifying the initial timer value in
  31. milliseconds.  If
  32. .I value
  33. == 0, then the current timer value remains unchanged.  If the longword that
  34. .I value
  35. points to contains 0, the timer is cancelled.
  36. .PP
  37. Upon expiration of the initial timer value, the timer value is reset to the
  38. longword pointed to by
  39. .I interval .
  40. If
  41. .I interval
  42. == 0, the previously requested interval remains unchanged. If the longword that
  43. .I interval
  44. points to contains 0, the timer will be cancelled upon its first expiration.
  45. .PP
  46. .I ovalue
  47. and
  48. .I ointerval
  49. point to longwords into which will be written the current value and interval
  50. of the timer.  If
  51. .I ovalue
  52. or
  53. .I ointerval
  54. == 0, the old values will not be passed back to the calling process.
  55. .SH RETURNS
  56. If an error occurs, a GEMDOS error code is returned.
  57. .PP
  58. Upon success, 0 is returned.
  59. .SH "SEE ALSO"
  60. .IR Pause (2),
  61. .IR Psignal (2),
  62. .IR Talarm (2)
  63. .SH BUGS
  64. Internal calculations are done in milliseconds, so setting a timer more than
  65. 2 million seconds or so into the future will not work correctly.
  66.  
  67. --
  68. entropy -- it's not just a good idea, it's the second law.
  69. Personal mail:      entropy@gnu.ai.mit.edu
  70. MiNT library mail:  entropy@terminator.rs.itd.umich.edu
  71. "what do you have against octal?" -jrb
  72.  
  73.